MachineLearningServices.json

{
  "swagger": "2.0",
  "info": {
    "version": "2018-01-01",
    "title": "Schema of Azure Machine Learning Services events published to Azure Event Grid",
    "description": "Describes the schema of the Azure Machine Learning Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent."
  },
  "paths": {},
  "definitions": {
    "MachineLearningServicesModelRegisteredEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.",
      "type": "object",
      "properties": {
        "modelName": {
          "description": "The name of the model that was registered.",
          "type": "string"
        },
        "modelVersion": {
          "description": "The version of the model that was registered.",
          "type": "string"
        },
        "modelTags": {
          "description": "The tags of the model that was registered.",
          "type": "object"
        },
        "modelProperties": {
          "description": "The properties of the model that was registered.",
          "type": "object"
        }
      }
    },
    "MachineLearningServicesModelDeployedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.",
      "type": "object",
      "properties": {
        "serviceName": {
          "description": "The name of the deployed service.",
          "type": "string"
        },
        "serviceComputeType": {
          "description": "The compute type (e.g. ACI, AKS) of the deployed service.",
          "type": "string"
        },
        "modelIds": {
          "description": "A common separated list of model IDs. The IDs of the models deployed in the service.",
          "type": "string"
        },
        "serviceTags": {
          "description": "The tags of the deployed service.",
          "type": "object"
        },
        "serviceProperties": {
          "description": "The properties of the deployed service.",
          "type": "object"
        }
      }
    },
    "MachineLearningServicesRunCompletedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.",
      "type": "object",
      "properties": {
        "experimentId": {
          "description": "The ID of the experiment that the run belongs to.",
          "type": "string"
        },
        "experimentName": {
          "description": "The name of the experiment that the run belongs to.",
          "type": "string"
        },
        "runId": {
          "description": "The ID of the Run that was completed.",
          "type": "string"
        },
        "runType": {
          "description": "The Run Type of the completed Run.",
          "type": "string"
        },
        "runTags": {
          "description": "The tags of the completed Run.",
          "type": "object"
        },
        "runProperties": {
          "description": "The properties of the completed Run.",
          "type": "object"
        }
      }
    },
    "MachineLearningServicesDatasetDriftDetectedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.",
      "type": "object",
      "properties": {
        "dataDriftId": {
          "description": "The ID of the data drift monitor that triggered the event.",
          "type": "string"
        },
        "dataDriftName": {
          "description": "The name of the data drift monitor that triggered the event.",
          "type": "string"
        },
        "runId": {
          "description": "The ID of the Run that detected data drift.",
          "type": "string"
        },
        "baseDatasetId": {
          "description": "The ID of the base Dataset used to detect drift.",
          "type": "string"
        },
        "targetDatasetId": {
          "description": "The ID of the target Dataset used to detect drift.",
          "type": "string"
        },
        "driftCoefficient": {
          "description": "The coefficient result that triggered the event.",
          "type": "number",
          "format": "double"
        },
        "startTime": {
          "description": "The start time of the target dataset time series that resulted in drift detection.",
          "type": "string",
          "format": "date-time"
        },
        "endTime": {
          "description": "The end time of the target dataset time series that resulted in drift detection.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "MachineLearningServicesRunStatusChangedEventData": {
      "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.",
      "type": "object",
      "properties": {
        "experimentId": {
          "description": "The ID of the experiment that the Machine Learning Run belongs to.",
          "type": "string"
        },
        "experimentName": {
          "description": "The name of the experiment that the Machine Learning Run belongs to.",
          "type": "string"
        },
        "runId": {
          "description": "The ID of the Machine Learning Run.",
          "type": "string"
        },
        "runType": {
          "description": "The Run Type of the Machine Learning Run.",
          "type": "string"
        },
        "runTags": {
          "description": "The tags of the Machine Learning Run.",
          "type": "object"
        },
        "runProperties": {
          "description": "The properties of the Machine Learning Run.",
          "type": "object"
        },
        "runStatus": {
          "description": "The status of the Machine Learning Run.",
          "type": "string"
        }
      }
    }
  }
}